home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / daystats.zip / DAYSTATS.DOC < prev    next >
Text File  |  1992-09-17  |  17KB  |  340 lines
  1.                                                                   Page  1
  2.  
  3.  
  4.           ╒══════════════════════════════════════════════════════╕
  5.           │                      DAYSTATS                        │
  6.           ├──────────────────────────────────────────────────────┤
  7.           │          A PCBoard Single Day Stats Program!         │
  8.           ├──────────────────────────────────────────────────────┤
  9.           │     Version 1.0    09/17/92   Copyright (c) 1992     │
  10.           ╘══════════════════════════════════════════════════════╛
  11.  
  12.  
  13.  
  14.  
  15. WHAT IS DAYSTATS ?
  16. -----------------
  17.  
  18. With the multitude of PCBoard utilities available, I was surprised
  19. that I had never seen a simple utility which would automatically
  20. (in your EVENT) produce a bulletin file which simply listed what
  21. happened on your BBS in one simple line, and gave you a visible history
  22. of each day's stats. Take a look at the sample bulletins and I think
  23. you will see immediately the simplicity and usefulness of the DAYSTATS.
  24.  
  25. PCBoard provided the perfect source for this information. The
  26. PCBSTATS.DAT file contains precisely what I wanted to know, distilled
  27. down into 4 major items: Calls, Messages, Uploads, and Downloads. Using
  28. the information provided by the PCBSTATS.DAT file, DAYSTATS will produce
  29. a simple but very meaningful bulletin showing you day by day how many
  30. calls, messages, uploads and downloads took place on your BBS. A simple
  31. glance at the bulletin and you can instantly see how your BBS is being
  32. utitilized over a period of time.
  33.  
  34. Sure, I know there are lots of other Stats programs out there. But I am
  35. not aware of one that gives me summary information about what happened on
  36. my BBS prior to yesterday. Most provide much more detail and information
  37. than DAYSTATS does, while DAYSTATS simply summarizes the major topics.
  38. In theory, DAYSTATS is not intended to replace the full-blown stats
  39. programs, but rather to enhance them by offering previously unavailable
  40. information in a FAST!!! simple program.
  41.  
  42. CAPABILITIES and LIMITATIONS
  43. ----------------------------
  44. DAYSTATS can currently handle PCBoard systems with up to 500 Nodes. Many
  45. of the routines used in DAYSTATS are written in assembler for speed and
  46. ease of error trapping, and smaller code size. DAYSTATS uses a config
  47. file, but can override most of the config file settings with command
  48. line switches for ease of use. Three types of bulletins can be produced:
  49. Single Line, GreenBar (computer paper), and Double Line. The header and
  50. output colors are totally configurable as well. DAYSTATS stores prior
  51. days history in a data file called DAYSTATS.DAT which includes node
  52. information as well as cummulative BBS stats. DAYSTATS has extensive
  53. error trapping and has been tested completely before being release.
  54.  
  55.  
  56.  
  57.  
  58. DISTRIBUTION FILES                                                Page  2
  59. -----------------
  60. Included in your ZIP file should at least be the following programs.
  61. If these files are not in the copy of the ZIP you have, call
  62. Xignals PCBoard and download a complete copy.
  63.  
  64. DAYSTATS.EXE      <-------- DAYSTATS Executable Program
  65. DAYSTATS.DOC      <-------- This Documentation
  66. DAYSTATS.CFG      <-------- Sample Configuration File
  67. SINGLE.BUL        <-------- Sample "single" line bulletin file
  68. DOUBLE.BUL        <-------- Sample "double" line bulletin file
  69. FILE_ID.DIZ       <-------- PCBoard upload description file
  70. README.TXT        <-------- Information on Cost etc...
  71. RESET.BAT         <-------- Example of how to reset PCBSTATS.DAT
  72.  
  73. OPERATION                                                         Page  2
  74. ---------
  75.  
  76. DAYSTATS will read in your PCBSTATS.DAT file, extract the information that
  77. it needs and produce a bulletin report of the day's BBS activity. It should
  78. be noted that if you do NOT currently reset your PCBSTATS.DAT file every
  79. day (or night) in your event, then DAYSTATS is probably of no use to you.
  80. DAYSTATS makes the assumption that your PCBSTATS.DAT file reflects only
  81. a single day's activity on the BBS. DAYSTATS will work regardless of
  82. whether or not you reset your stats, but the information you would get from
  83. DAYSTATS would basically be meaningless if you didn't reset PCBSTATS.DAT
  84. after running DAYSTATS every day. I have included a sample rest batch file
  85. for those who don't know how to do it. I suggest you read your PCBoard manual
  86. or ask for more accurate help from CDC if you are certain about how to reset
  87. your PCBSTATS.DAT file.
  88.  
  89. Generally your order of processing would be to run DAYSTATS and then
  90. immediately after successful completetion of DAYSTATS, reset your
  91. PCBSTATS.DAT file.
  92.  
  93.  
  94. The General syntax for running DAYSTATS is:
  95.  
  96. C:\> DAYSTATS [/C=xx /B=xx /L=xx /U=xx /T=xx /S=xx /D=xx] /? or /HELP
  97.               [optional parameters]
  98.  
  99. ex: C:\> DAYSTATS
  100.     Daystats alone will use the default config file and process as
  101.     defined in the .CFG file. <THIS IS THE BEST RECOMMENDED METHOD!>
  102.  
  103. ex: C:\> DAYSTATS /C=MY.CFG /B=BLT30
  104.     Daystats would use the file "MY.CFG" in place of "DAYSTATS.CFG" and
  105.     force the output to go to BLT30.
  106.  
  107. ex: C:\> DAYSTATS /C:\MY.CFG /B=BLT30 /U=NO /D=CURRENT
  108.     Same as above, but will also NOT update the history data file and
  109.     will use the current day instead of yesterday's date (see /D desc.)
  110.  
  111. Basically, you can specify the command line options in any order you
  112. like. I strongly recommend you leave a space between the parameters, but
  113. the program will work without separating spaces.
  114.  
  115. If you forget the syntax, then you can get a brief description of the
  116. command line syntax by typing:  DAYSTATS /?
  117.                            or:  DAYSTATS /Help.
  118.  
  119. <CONFIG FILE>                                                     Page  3
  120. DAYSTATS uses a simple Configuration File to store the parameters which
  121. the program needs such as the name and location of your PCBSTATS.DAT
  122. file and desired output bulletin. Your BBS name and desired bulletin
  123. colors are also defined in the configuration file.
  124.  
  125. NOTE: I STRONGLY suggest you name your configuration file DAYSTATS.CFG
  126.       since that is what the default name is, which DAYSTATS looks for
  127.       upon start up. You can always override the default name with the
  128.       /C=<config.file> parameter, but if you ever forget, DAYSTATS will
  129.       attempt to use "DAYSTATS.CFG" and if it's not found, the program
  130.       will not function properly,(i.e., it won't run).
  131.  
  132. CONFIGURATION FILE
  133. ------------------
  134. D:\PCB\MAIN\PCBSTATS.DAT           <------ (LINE 1 )
  135. D:\PCB\GEN\BLT30                   <------ (LINE 2 )
  136. Xignals PCBoard                    <------ (LINE 3 )
  137. @X1E                               <------ (LINE 4 )
  138. @X1A                               <------ (LINE 5 )
  139. @X0B                               <------ (LINE 6 )
  140. GREENBAR                           <------ (LINE 7 )
  141.  
  142. The CONFIGURATION File is REQUIRED! DAYSTATS will NOT work without it.
  143. The file must contain all seven lines with valid values on each line
  144. and they must be in the order presented above.
  145.  
  146. LINE 01  - Name and Location of your PCBSTATS.DAT file
  147. LINE 02  - Name and Location of the Bulletin file to be created
  148. LINE 03  - Name of your BBS
  149. LINE 04  - Header BORDER colors           SEE NOTE1:( about PCBoard     )
  150. LINE 05  - BBS Name Colors (in header).             ( @Xxx color codes! )
  151. LINE 06  - Default Text colors for Single and Double Type bulletins.
  152. LINE 07  - This field is the indicator for which type of bulletin to
  153.            produce. SEE NOTE2:
  154.  
  155. NOTE1: PCBOARD @Xxx COLOR CODES
  156. -------------------------------
  157. It is assumed you are at least FAMILIAR with running PCBoard and
  158. that you will know about PCBoard @Xxx color codes. I chose to
  159. simply allow the user to directly enter them into the program rather
  160. than try to make a table of colors etc and decypher all the codes.
  161. If you have difficulty with @Xxx color codes, I suggest you leave
  162. them as delivered (they look ok) and ask CDC for assistance with color
  163. codes.
  164.  
  165. NOTE2: BULLETIN OUTPUT TYPES
  166. ----------------------------
  167. There are 3 types of bulletins which DAYSTATS will produce. Each of the
  168. three has the same header, but the data following the header can be
  169. displayed either in GREENBAR (printer paper), or as a SINGLE line of
  170. information or as a DOUBLE line (one stats + a seperator line). See the
  171. included sample bulletins for Double and Single to get an idea of which
  172. style you would like. There is no example file for GreenBar, but it will
  173. look like the Single, and output will be on alternating White and Green
  174. backgounds. In ALL three bulletin types, the most recent day's stats
  175. will be listed first and and subsequent days will be listed in
  176. descending order by date, so a quick glance at the bulletin and you can
  177. see exactly how many calls, messages, uploads, and downloads you BBS had
  178. and on what days.
  179.  
  180.  
  181. COMMAND LINE SWITCHES                                             Page  4
  182. ---------------------
  183. Once again, I stress, that my intention when writing DAYSTATS was to
  184. have all parameter information that the program needed to be contained
  185. within a configuration file. That was, however, my idea and someone will
  186. most likely want to change things to suit their needs so I added the
  187. ability to override most of the items in the configuration file with
  188. command line switches. If your config file accurately reflects how you
  189. want your bulletin to look and function, then you do not need to specify
  190. any additional parameters on the command line.
  191.  
  192. If you need to specify different or additional parameters, then
  193. following is a list of the parameters and their functions. Parameters
  194. MUST be listed as /x= (where x = letter of parameter). The = sign must
  195. also be included. If you require more than one parameter, you may
  196. separate them with a space or you may list them all together with no
  197. spaces. Either way is valid.
  198.  
  199. ex: C:\> DAYSTATS /C=MY.CFG /B=BLT30 /U=NO /D=CURRENT
  200. or
  201. ex: C:\> DAYSTATS /C=MY.CFG/B=BLT30/U=NO/D=CURRENT
  202.  
  203. Both of those examples are valid.
  204.  
  205. SWITCHES
  206. --------
  207.  
  208. /?               - Will display a one page help screen (with parameter info)
  209. /HELP            - Same function as /?
  210.  
  211. /C=Config File   - If you need an alternative configuration file, you
  212.                    may specify a new one. Full Drive, path, and filename
  213.                    are supported.
  214.  
  215. /D=CURRENT       - DAYSTATS, by default, assumes you are running your EVENT
  216.                    in the middle of the night (after midnight). If you want
  217.                    stats for Thursday, and your event is actually running
  218.                    at 2:00am on Friday, then you would need to subtract one
  219.                    day from the Friday date in order to display "Thursday's"
  220.                    proper date. The /D=CURRENT parameter overrides that
  221.                    function and will display the true date which is current
  222.                    at the time of DAYSTATS execution. The keyword CURRENT
  223.                    is the only option associated with /D=.
  224.  
  225. /L=@Xxx          - If you are using the DOUBLE style bulletin and you would
  226.                    like the separator line to be a different color from the
  227.                    text lines, using the /L=@Xxx allows you to specify a
  228.                    PCBoard @ color code for the line. This parameter will
  229.                    have no effect on SINGLE or GREENBAR bulletins.
  230.  
  231. /T=Type          - If you want to change the Bulletin Type, you may use the
  232.                    /T=type command where type = GREENBAR, SINGLE or DOUBLE.
  233.                    It should be noted that DAYSTATS creates a completely new
  234.                    bulletin everytime it is invoked, so if you started out
  235.                    with a SINGLE, and wanted to see GREENBAR the next time,
  236.                    you do not have to start all over. DAYSTATS will simply
  237.                    build your new bulletin with the style type you wanted.
  238.                    <See /U= parm for companion option>
  239.  
  240.                                                                   Page  5
  241.  
  242. /U=YES or NO     - The /U= option tells DAYSTATS whether or not to update
  243.                    the DAYSTATS.DAT history file. This might be useful if
  244.                    you wanted to experiment with colors or bulletin types.
  245.                    By default, Daystats will append the new information from
  246.                    PCBSTATS.DAT to the history file (DAYSTATS.DAT), so if
  247.                    you ran DAYSTATS 10 times on the same PCBSTATS.DAT file
  248.                    without the /U=NO switch, you would then have 10 records
  249.                    of the same data and no way to remove the duplicate
  250.                    entries. Be careful with this file since the DAYSTATS.DAT
  251.                    file is crucial to the operation of DAYSTATS.
  252.                    NOTE: If DAYSTATS.DAT does not exist, and you use the
  253.                          /U=NO parameter, DAYSTATS will not work.
  254.  
  255. /B=Bulletin File - If you wanted to specify an alternative bulletin file
  256.                    other than what is defined in DAYSTATS.CFG, then you
  257.                    may use /B=<drive,path,filename> of a new bulletin file.
  258.  
  259. /S=StatFile      - If you wanted to specify an alternative PCBSTATS.DAT
  260.                    file, you can use the /S=<drive,path,filename> of a
  261.                    different PCBSTATS.DAT file. The only reason I can
  262.                    think of for using this is testing. But it's here if
  263.                    you want it. :-)
  264.  
  265. Once again all of these switches except for the Help , /L= and /D= are
  266. and should be defined in your DAYSTATS.CFG file.
  267.  
  268.  
  269. OUTPUT FILES
  270. ------------
  271. DAYSTATS uses several files during processing.  Every effort has been
  272. made to ensure that if something (power outage or lockup etc..) happens
  273. at anytime during the running of DAYSTATS, that no data or files are in
  274. danger of being lost.
  275.  
  276. DAYSTATS.DAT is the accumulated history file of each day's statistical
  277.              information. Whatever you do, DO NOT alter this file in
  278.              any way. The record lengths and file size are fixed and
  279.              the program depends on their integrity.
  280.  
  281. DAYSTATS.TMP is the temporary bulletin file which DAYSTATS creates. If
  282.              all processing is successful, this file becomes your
  283.              specified Bulletin file. Unless there is a program or DOS
  284.              error, you will probably ever see this file, but I think
  285.              it is a good idea to let you know ahead of time what it is.
  286.  
  287.  
  288.  
  289.  
  290. DISCLAIMER (you knew! this was coming ...)                        Page  6
  291. __________________________________________
  292.  
  293. MilesWare hereby disclaims all warranties relating to this product,
  294. whether express or implied, including without limitation any implied
  295. warranties of merchantability or fitness for a particular purpose.
  296. MilesWare cannot and will not be liable for any special, incidental,
  297. consequential, indirect or similar damages due to loss of data or
  298. any other reason, even if MilesWare or an authorized MilesWare
  299. agent has been advised of the possibility of such damages. In no
  300. event shall the liability for any damages ever exceed the price
  301. paid for the license to use software, regardless of the form
  302. and/or extent of the claim. The user of this program bears all risk
  303. as to the quality and performance of the software.
  304.  
  305.  
  306. COPYRIGHT AND ACKNOWLEDGEMENTS
  307. ------------------------------
  308.  
  309.     DAYSTATS is not public domain. It is copyrighted software.
  310.        Copyright (c) 1992 MilesWare,  All Rights Reserved.
  311.  
  312. I would like to thank Richard Pope and Floyd Vest for assisting
  313. me with the more difficult programming routines. It's absolutely
  314. frightening how similar Amiga Basic is to QuickBasic. Thanks guys.
  315.  
  316. DAYSTATS is written completely in Microsoft QuickBasic 4.5 with
  317. assembler routines thrown in here and there for good measure.
  318.  
  319. SUPPORT AND UPDATES
  320. -------------------
  321.  
  322. The Latest copy of DAYSTATS (and other PCBoard utils by MilesWare) can by
  323. always be found on:      XIGNALS PCBoard
  324.                          (205) 821-4664  14.4 USR HST/DUAL
  325.                          Miles Lester (Author and Sysop)
  326.                          Auburn, Alabama
  327.  
  328. If you have problems or suggestions or just want to say thanks for a
  329. simple but useful utility, then you can reach me via the following
  330. methods.
  331.  
  332. SALT AIR BBS             Home of PCBoard --- I call at least weekly
  333. ILink                    In the Ilink sysop's conference
  334. InterNet                 mlester@ducvax.auburn.edu
  335. BitNet                   mlester@auducvax.bitnet
  336. Xignals PCBoard          number is posted above etc..
  337. U.S. Postal Service      Miles Lester
  338.                          1001 E. Samford Ave.
  339.                          Auburn, AL 36830
  340.